home *** CD-ROM | disk | FTP | other *** search
/ Amiga Format CD 6 / Amiga Format AFCD06 (Nov 1996, Issue 90).iso / serious / shareware / workbench / dosprefs / dosprefs.doc < prev    next >
Text File  |  1996-09-04  |  12KB  |  352 lines
  1. 1. About DOSPrefs
  2.  
  3. DOSPrefs is a small commodity with three functions:
  4.  
  5. 1. Control the "Wildstar"-flag of the Amiga OS 2.0+ dos.library.
  6.  
  7. 2. Control the "Noclick"-flags of the Amiga OS 2.0+ trackdisk.device.
  8.  
  9. 3. Provide an all new "Unixdirs"-feature.
  10.  
  11. These functions can be controlled when DOSPrefs is started by Tooltypes,
  12. or at runtime by Intuition(tm)-menus.
  13.  
  14. Furthermore, DOSPrefs is localized, using the locale.library* (requiring
  15. Workbench 2.1+) to adapt to your prefered language, and provides a context-
  16. sensitive help system with AmigaGuide(tm) (requiring amigaguide.library V34+).
  17. (Simply press "Help" !)
  18.  
  19. * currently, catalog and amigaguide help files for the following languages
  20. are included:
  21.  
  22. english (catalog built in)
  23. deutsch
  24. italiano
  25. dansk (catalog file only)
  26. español (catalog file only)
  27. français (catalog file only)
  28.  
  29. If you want, you can help me to provide support for additional languages.
  30. All you have to do is fill in the empty catalog source file DOSPrefs.ct and
  31. translate the helpfile catalogs/english/DOSPrefs.guide (note: you must not
  32. translate the @node names !!), and mail them to me (see below for my
  33. addresses). I will include them in the next release. DO NOT TRANSLATE THE
  34. CATALOG DESCRIPTOR FILE DOSPrefs.cd !!!
  35.  
  36. 2. Requirements
  37.  
  38. DOSPrefs requires at least Kickstart 2.04. To be more exact, the following
  39. libraries are needed:
  40.  
  41. exec.library V37
  42. dos.library V37
  43. commodities.library V37
  44. icon.library V37
  45. utility.library V37
  46. intuition.library V37
  47. gadtools.library V37
  48. graphics.library V37
  49. locale.library V38*
  50. amigaguide.library V34*
  51.  
  52. *: optional
  53.  
  54. 3. Installation
  55.  
  56. If you have the C= Installer program, simply double-click on the 
  57. Install-DOSPref Icon to start the installation. If you do not have the
  58. installer, this is what you have to do:
  59.  
  60. copy DOSPrefs SYS:WBStartup clone
  61. copy DOSPrefs.info SYS:WBStartup clone
  62. copy catalogs LOCALE:catalogs all clone ; if you have WB 2.1 +
  63. copy help HELP: all clone               ; if you have amigaguide
  64.  
  65. You may of course opt to install catalogs and helpfiles for only some of the
  66. provided languages.
  67.  
  68. NOTE: If you have AmigaGuide, DOSPrefs needs a HELP: assign. The standard
  69. for this assign is the directory locale:help. 
  70.  
  71. 4. Tooltypes
  72.  
  73. When DOSPrefs is started from the Workbench(tm), it evaluates the tooltypes
  74. of its icon; when it is started from the CLI, it evaluates the commandline
  75. arguments (the recognized Parameters are in both cases the same). The 
  76. parameters recognized by DOSPrefs are summarized in the following template:
  77.  
  78. CX_PRIORITY/N/K,CX_POPKEY/K,CX_POPUP/K,PUBSCREEN/K,WILDSTAR/K,UNIXDIRS/K,
  79. NOCLICK/K
  80.  
  81. CX_PRIORITY (default: 0): This is the priority for the commodities event
  82. handling mechanism.
  83.  
  84. CX_POPKEY (default: lalt d): This is the hotkey that causes DOSPrefs to
  85. show its interface. (By the way: starting DOSPrefs a second time will have
  86. the same effect as pressing the hot key; the first DOSPrefs will pop up and
  87. the second will terminate immediately.)
  88.  
  89. CX_POPUP (default: yes): This determines, if DOSPrefs is to show its
  90. interface on program startup.
  91.  
  92. PUBSCREEN (no default): This is the name of the public screen on which
  93. DOSPrefs is to open its interface. If this parameter is not specified or
  94. the given screen cannot be found, DOSPrefs opens its interface on the
  95. default public screen.
  96.  
  97. WILDSTAR (default: yes): This determines, if DOSPrefs is to set the
  98. wildstar flag of the dos.library on startup.
  99.  
  100. UNIXDIRS (default: yes): This determines, if DOSPrefs is to install the
  101. unixdirs-patch on startup.
  102.  
  103. NOCLICK (no default): This determines for which floppy drives DOSPrefs
  104. sets the noclick-flags on startup. You have to list the
  105. drives seperated by "|"s, e.g. "DF1:", "DF0:|DF1:|DF2:".
  106.  
  107. CAUTION: If an empty drive clicks even if you have set the noclick flag
  108. for this drive, unset the flag immediately. Your disk drive may be damaged
  109. otherwise.
  110.  
  111. 5. GUI
  112.  
  113. DOSPrefs has both menus and gadgets. The gadgets duplicate the functions of
  114. the "Settings" menu. 
  115.  
  116. DOSPrefs has the following Menu-structure (using the english language):
  117.  
  118.    Project              Settings
  119.      Save                 WildStar
  120.      About                UnixDirs
  121.      Enable               NoClick
  122.      Disable                DF0:
  123.      Hide                   DF1:
  124.      Quit                   DF2:
  125.                             DF3:
  126.                             
  127. 5.1 The Project Menu
  128.  
  129. "Save" saves the current settings in the DOSPrefs.info file.
  130.  
  131. "About" shows a nice, short copyright message. ;-)
  132.  
  133. "Enable" brings DOSPrefs to the active state. If it is already active,
  134. the "Enable" item is ghosted.
  135.  
  136. "Disable" brings DOSPrefs to the inactive state, if possible. If it is
  137. already inactive, the "Disable" item is ghosted.
  138. This operation may fail if the "unixdirs"-patch cannot be undone.
  139.  
  140. "Hide" hides the user interface of DOSPrefs. (Clicking on the
  141. closegadget has the same effect.) To make the interface visible again,
  142. press the hot key or use the commodities exchange program.
  143.  
  144. "Quit" terminates DOSPrefs, if possible.
  145. This may fail if the "unixdirs"-patch cannot be undone.
  146.  
  147. 5.2 The Settings Menu
  148.  
  149. 5.2.1 The WildStar Item
  150.  
  151. "WildStar" toggles the wildstar-flag of the dos.library. If the flag is set,
  152. "*" will be recognized as an abbreviation for "#?" in search patterns.
  153.  
  154. 5.2.2 The UnixDirs Item
  155.  
  156. "UnixDirs" enables the unixdirs-patch of the dos.library. What does this
  157. patch do ? It allows the use of the special directory names ".." and "."
  158. like under UNIX (thus the name of the function).
  159.  
  160. ".." represents the parent-directory of the current directory (like "/").
  161. So "../blabla" is identical to "/blabla", etc.
  162.  
  163. "." is the current directory. Thus you can say "copy ../blabla/*.c .".
  164.  
  165. Starting with version 3.0 of DosPrefs, the UnixDirs mechanism has been
  166. extended:
  167.  
  168. You can now change the style of the pathname translation by setting
  169. the local environment variable "PathStyle". Only the processes
  170. that have this variable set are affected.
  171.  
  172. If you set "PathStyle" to "Amiga", the pathname tranlation is completely
  173. disabled for this process.
  174.  
  175. If you set "PathStyle" to "Unix", in addition to the "." and ".."
  176. translation, path names starting with "/" are translated like 
  177. ixemul.library-using programs do, e.g.:
  178.  
  179. /usr/archive -> usr:archive
  180. /local/bin   -> local:bin
  181. /foo//bar    -> foo:bar      !!
  182.  
  183. In addition to that, two special translations are activated:
  184.  
  185. /dev/null    -> NIL:
  186. /dev/tty     -> CONSOLE:
  187.  
  188. ATTENTION: As there is no equivalent to the unix root directory "/",
  189. and in order to enhance compatibility, the path "/" still means
  190. the parent of the current directory !
  191.  
  192. If you want to set PathStyle globally for all processes, add the line
  193.  
  194. Set PathStyle "Unix"
  195.  
  196. to s:User-Startup.
  197.  
  198. Any other value of PathStyle or not setting it at all will give the
  199. default behaviour (only . and .. translation).
  200.  
  201. NOTE: Due to the nature of library patches, it may not be possible to
  202. unpatch the dos.library if the patched functions are in use.
  203. DOSPrefs will detect this and put up a requester allowing you to try again 
  204. to unpatch the dos.library or to cancel the operation.
  205.  
  206. Here is an alphabetic list of the patched library funtions:
  207.  
  208. AssignLate
  209. AssignPath
  210. CreateDir
  211. DeleteFile
  212. GetDeviceProc
  213. LoadSeg
  214. Lock
  215. MakeLink
  216. NewLoadSeg
  217. Open
  218. Rename
  219. SetComment
  220. SetFileDate
  221. SetOwner*
  222. SetProtection
  223.  
  224. * V39 dos.library funtion
  225.  
  226. NOTE: In version 1.0, DOSPrefs patched some more functions. This was not a
  227. good idea - it caused weird problems when I improved the string conversion
  228. routine. 
  229.  
  230. 5.2.3 The NoClick SubMenu
  231.  
  232. The "NoClick" item has four subitems labeled "DF0:" to "DF3:", that allow you
  233. to set the noclick-flag individually for each of your disk drives. If a disk
  234. drive does not exist, its subitem is disabled.
  235.  
  236. CAUTION: If an empty drive clicks even if you have set the noclick flag
  237. for this drive, unset the flag immediately. Your disk drive may be damaged
  238. otherwise.
  239.  
  240. 6. Licence
  241.  
  242. DOSPrefs is Freeware. You may freely redistribute the complete, unchanged
  243. archive. You may not change any of the files or distribute an incomplete
  244. version of the archive. (Of course, you may change ToolTypes in the .info
  245. files. :-)) You may not add files to the archive, except ony .displayme -
  246. file with your mailbox-logo if - and only if - you have the archive freely
  247. available for download.
  248.  
  249. 7. Disclaimer & Warranty
  250.  
  251.      THERE IS NO WARRANTY FOR THE PROGRAMS, TO THE EXTENT PERMITTED
  252.      BY APPLICABLE LAW.  EXCEPT WHEN OTHERWISE STATED IN WRITING THE
  253.      COPYRIGHT HOLDERS AND/OR OTHER PARTIES PROVIDE THE PROGRAMS "AS
  254.      IS" WITHOUT WARRANTY OF ANY KIND, EITHER EXPRESSED OR IMPLIED,
  255.      INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF
  256.      MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.  THE
  257.      ENTIRE RISK AS TO THE QUALITY AND PERFORMANCE OF THE PROGRAMS IS
  258.      WITH YOU.  SHOULD THE PROGRAMS PROVE DEFECTIVE, YOU ASSUME THE
  259.      COST OF ALL NECESSARY SERVICING, REPAIR OR CORRECTION.  
  260.  
  261.        IN NO EVENT UNLESS REQUIRED BY APPLICABLE LAW OR AGREED TO IN
  262.      WRITING WILL ANY COPYRIGHT HOLDER, OR ANY OTHER PARTY WHO MAY
  263.      REDISTRIBUTE THE PROGRAMS AS PERMITTED ABOVE, BE LIABLE TO YOU
  264.      FOR DAMAGES, INCLUDING ANY GENERAL, SPECIAL, INCIDENTAL OR
  265.      CONSEQUENTIAL DAMAGES ARISING OUT OF THE USE OR INABILITY TO USE
  266.      THE PROGRAMS (INCLUDING BUT NOT LIMITED TO LOSS OF DATA OR DATA
  267.      BEING RENDERED INACCURATE OR LOSSES SUSTAINED BY YOU OR THIRD
  268.      PARTIES OR A FAILURE OF THE PROGRAMS TO OPERATE WITH ANY OTHER
  269.      PROGRAMS), EVEN IF SUCH HOLDER OR OTHER PARTY HAS BEEN ADVISED
  270.      OF THE POSSIBILITY OF SUCH DAMAGES.  
  271.  
  272. There is no warranty at all. Use at your own risk.
  273.  
  274. 8. Bug Reports
  275.  
  276. Report bugs & improvement suggestions to:
  277.  
  278. SnailMail:
  279.   Norbert Püschel
  280.   Am Propsthof 15
  281.   53121 Bonn
  282.   Germany
  283.  
  284. or
  285.  
  286. EMail:
  287.   pueschel@imsdd.meb.uni-bonn.de
  288.   nobbi@zaphod.rhein.de
  289.  
  290.   2:2453/30.14  (FidoNet)
  291.  
  292. 9. Credits
  293.  
  294. Thanks to the TrapDoor-Team for the disclaimer I shamelessly copied from
  295. them. ;-)
  296.  
  297. Thanks to Piergiorgio Ghezzo for writing italian catalog and guide files.
  298. Thanks to Klaus Alexander Seistrup for writing a danish catalog.
  299. Thanks to Florent Monteilhet for writing a french catalog & help file.
  300. Thanks to Jack Holt for writing a spanish catalog.
  301.  
  302. 10. Version History
  303.  
  304.   1.0 (.07.93)
  305.   - first public release
  306.  
  307.   1.1 (.03.94)
  308.   - reduced number of patched functions. Some patches were superfluous,
  309.     some even potentially dangerous.
  310.   - improved string conversion routine. Now, the strings are no longer
  311.     patched "in place" but copied & converted onto the stack.
  312.  
  313.   1.2 (16.06.94)
  314.   - fixed bug in LoadSeg()-patch that caused programs with overlays to
  315.     crash. Thanks to Robert Reiswig for the bug report, shame to CBM for
  316.     the bad documentation.
  317.  
  318.   2.0 (05.07.94)
  319.   - improved GUI. Now has some checkbox gadgets in addition to menus.
  320.   - added a function to save the current settings in DOSPrefs.info
  321.   - improved patching mechanism. Now uses a jumptable; thus, DOSPrefs can
  322.     exit even if someone changed the patched vectors in dos.library.
  323.   - now detects if SetMan or SaferPatches is installed (skips library
  324.     vector change detection in this cases) (suggested by Gunther Nikl).
  325.   - moved the code that is not always needed (GUI, etc.) into an overlay.
  326.   - fixed string conversion function. Now processes names ending in .
  327.     correctly.
  328.   - improved help system. Now searches for guide files in your prefered
  329.     languages, defaulting to english if none are found.
  330.  
  331.   2.1 (11.07.94)
  332.   - included danish catalog file and italian catalog and guide files.
  333.   - inserted kludge in Open() and Lock() so that braindead programs
  334.     (uuencodex) that rely on condition codes being set after system call
  335.     work again (requested by Robert Reiswig).
  336.   - updated installer routine for additional catalogs.
  337.   - included DOSPrefs.cd file in distribution (requested by several people).
  338.     PLEASE, do NOT translate the .cd file but the .ct file !!! (and send it
  339.     to me).
  340.  
  341.   2.2 (14.07.94)
  342.   - included french catalog file.
  343.   - fixed (hopefully) cache clearing bug that could crash 68040 Amigas with 
  344.     copyback enabled (reported by Frank Kroll).
  345.  
  346.   3.0 (30.08.96)
  347.   - included spanish catalog file.
  348.   - updated french catalog file.
  349.   - added french guide file.
  350.  
  351.   - added PathStyle environment variable to change path translation.
  352.